/
InterceptionResult`1.xml
140 lines (140 loc) · 8.11 KB
/
InterceptionResult`1.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<Type Name="InterceptionResult<TResult>" FullName="Microsoft.EntityFrameworkCore.Diagnostics.InterceptionResult<TResult>">
<TypeSignature Language="C#" Value="public readonly struct InterceptionResult<TResult>" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit InterceptionResult`1<TResult> extends System.ValueType" />
<TypeSignature Language="DocId" Value="T:Microsoft.EntityFrameworkCore.Diagnostics.InterceptionResult`1" />
<TypeSignature Language="VB.NET" Value="Public Structure InterceptionResult(Of TResult)" />
<TypeSignature Language="F#" Value="type InterceptionResult<'Result> = struct" />
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="TResult" />
</TypeParameters>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="efcore-3.0;efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.IsReadOnly>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<typeparam name="TResult">The new result to use.</typeparam>
<summary>
Represents a result from an <see cref="T:Microsoft.EntityFrameworkCore.Diagnostics.IInterceptor" /> such as an <see cref="T:Microsoft.EntityFrameworkCore.Diagnostics.ISaveChangesInterceptor" /> to allow
suppression of the normal operation being intercepted.
</summary>
<remarks>
<para>
A value of this type is passed to all interceptor methods that are called before the operation
being intercepted is executed.
Typically the interceptor should return the value passed in.
However, creating a result with <see cref="M:Microsoft.EntityFrameworkCore.Diagnostics.InterceptionResult`1.SuppressWithResult(`0)" /> causes the operation being
intercepted to be suppressed; that is, the operation is not executed.
The value in the result is then used as a substitute return value for the operation that was suppressed.
</para>
<para>
See <see href="https://aka.ms/efcore-docs-interceptors">EF Core interceptors</see> for more information and examples.
</para>
</remarks>
</Docs>
<Members>
<Member MemberName="HasResult">
<MemberSignature Language="C#" Value="public bool HasResult { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool HasResult" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Diagnostics.InterceptionResult`1.HasResult" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property HasResult As Boolean" />
<MemberSignature Language="F#" Value="member this.HasResult : bool" Usage="Microsoft.EntityFrameworkCore.Diagnostics.InterceptionResult<'Result>.HasResult" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
If true, then interception is suppressed, and <see cref="P:Microsoft.EntityFrameworkCore.Diagnostics.InterceptionResult`1.Result" /> contains the result to use.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Result">
<MemberSignature Language="C#" Value="public TResult Result { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance !TResult Result" />
<MemberSignature Language="DocId" Value="P:Microsoft.EntityFrameworkCore.Diagnostics.InterceptionResult`1.Result" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Result As TResult" />
<MemberSignature Language="F#" Value="member this.Result : 'Result" Usage="Microsoft.EntityFrameworkCore.Diagnostics.InterceptionResult<'Result>.Result" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TResult</ReturnType>
</ReturnValue>
<Docs>
<summary>
The result to use.
</summary>
<value>To be added.</value>
<remarks>
The property can only be accessed if <see cref="P:Microsoft.EntityFrameworkCore.Diagnostics.InterceptionResult`1.HasResult" /> is true. The concept here
is the same as <see cref="P:System.Nullable`1.Value" /> and <see cref="P:System.Nullable`1.HasValue" /></remarks>
<exception cref="T:System.InvalidOperationException">when <see cref="P:Microsoft.EntityFrameworkCore.Diagnostics.InterceptionResult`1.Result" /> is <see langword="false" />.</exception>
</Docs>
</Member>
<Member MemberName="SuppressWithResult">
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.Diagnostics.InterceptionResult<TResult> SuppressWithResult (TResult result);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Microsoft.EntityFrameworkCore.Diagnostics.InterceptionResult`1<!TResult> SuppressWithResult(!TResult result) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Diagnostics.InterceptionResult`1.SuppressWithResult(`0)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function SuppressWithResult (result As TResult) As InterceptionResult(Of TResult)" />
<MemberSignature Language="F#" Value="static member SuppressWithResult : 'Result -> Microsoft.EntityFrameworkCore.Diagnostics.InterceptionResult<'Result>" Usage="Microsoft.EntityFrameworkCore.Diagnostics.InterceptionResult<'Result>.SuppressWithResult result" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.Diagnostics.InterceptionResult<TResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="TResult" />
</Parameters>
<Docs>
<param name="result">The result to use.</param>
<summary>
Creates a new <see cref="T:Microsoft.EntityFrameworkCore.Diagnostics.InterceptionResult`1" /> instance indicating that
execution should be suppressed and the given result should be used instead.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>